<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>wdttb: xwdttb_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">wdttb
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xwdttb__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xwdttb_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains a design example using the Watchdog Timer Timebase driver (<a class="el" href="struct_x_wdt_tb.html" title="The XWdtTb driver instance data. ">XWdtTb</a>) and hardware device. </p>
<dl class="section note"><dt>Note</dt><dd></dd></dl>
<p>None.</p>
<p>MODIFICATION HISTORY:</p>
<pre>
  Ver   Who  Date     Changes
<hr/>

  1.00b jhl  02/13/02 First release
  1.00b sv   04/26/05 Minor changes to comply to Doxygen and coding guidelines
  2.00a ktn  12/02/09 Updated the example to use the HAL APIs/macros.
                      Updated this example to check for Watchdog timer reset
                      condition instead of timer expiry state to avoid a race
                      condition
  4.0   sha  02/04/16 Added debug messages.
                      Updated WatchdogTimebase.RegBaseAddress -&gt;
                      WatchdogTimebase.Config.BaseAddr.
                      Calling XWdtTb_LookupConfig and XWdtTb_CfgInitialize
                      functions instead of XWdtTb_Initialize for
                      initialization.
*</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a7487434503f488732a56cfcfaccaa8de"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xwdttb__example_8c.html#a7487434503f488732a56cfcfaccaa8de">WdtTbExample</a> (u16 DeviceId)</td></tr>
<tr class="memdesc:a7487434503f488732a56cfcfaccaa8de"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function tests the functioning of the TimeBase WatchDog Timer module in the polled mode.  <a href="#a7487434503f488732a56cfcfaccaa8de">More...</a><br /></td></tr>
<tr class="separator:a7487434503f488732a56cfcfaccaa8de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xwdttb__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:a840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function to call the Wdttb driver example.  <a href="#a840291bc02cba5474a4cb46a9b9566fe">More...</a><br /></td></tr>
<tr class="separator:a840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a840291bc02cba5474a4cb46a9b9566fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a840291bc02cba5474a4cb46a9b9566fe">&#9670;&nbsp;</a></span>main()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function to call the Wdttb driver example. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if example ran successfully.</li>
<li>XST_FAILURE if unsuccessful.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xwdttb__example_8c.html#a7487434503f488732a56cfcfaccaa8de">WdtTbExample()</a>.</p>

</div>
</div>
<a id="a7487434503f488732a56cfcfaccaa8de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7487434503f488732a56cfcfaccaa8de">&#9670;&nbsp;</a></span>WdtTbExample()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int WdtTbExample </td>
          <td>(</td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function tests the functioning of the TimeBase WatchDog Timer module in the polled mode. </p>
<p>After one expiration of the WDT timeout interval, the WDT state bit is set to one in the status register. If the state bit is not cleared (by writing a 1 to the state bit) before the next expiration of the timeout interval, a WDT reset is generated.</p>
<p>This function checks for Watchdog timer reset condition in two timer expiry state.</p>
<p>This function may require some time (seconds or even minutes) to execute because it waits for the watchdog timer to expire.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>is the XPAR_&lt;WDTB_instance&gt;_DEVICE_ID value from xparameters.h.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if WRS bit is not set in next two subsequent timer expiry state.</li>
<li>XST_FAILURE otherwise.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_wdt_tb___config.html#a3867e6f3038fe367e0072a85125f5391">XWdtTb_Config::BaseAddr</a>, <a class="el" href="struct_x_wdt_tb.html#a9841f60870d97e7bc296dd419c75023f">XWdtTb::Config</a>, <a class="el" href="group__wdttb__v4__0.html#ga27ad871e840a7a6797ff456bdd3ad34e">XWdtTb_CfgInitialize()</a>, <a class="el" href="group__wdttb__v4__0.html#gabd0fe163a6678764b47f39bcced63bed">XWdtTb_IsWdtExpired()</a>, <a class="el" href="group__wdttb__v4__0.html#ga14a07eb4184572676004f3d965ebb7fd">XWdtTb_LookupConfig()</a>, <a class="el" href="group__wdttb__v4__0.html#gafa6b4b0d4c816cd9bd6da3c9fe7caac3">XWdtTb_ReadReg</a>, <a class="el" href="group__wdttb__v4__0.html#gae1f036194a32943f4e058f51b8f64358">XWdtTb_RestartWdt()</a>, <a class="el" href="group__wdttb__v4__0.html#gaba9ba27ac3898e4a28aa10a621b4593b">XWdtTb_SelfTest()</a>, <a class="el" href="group__wdttb__v4__0.html#gaab195e280eca1e2985509d954c2e4e52">XWdtTb_Start()</a>, <a class="el" href="group__wdttb__v4__0.html#gacd5617bce061deaa57743ea46008daf8">XWdtTb_Stop()</a>, <a class="el" href="group__wdttb__v4__0.html#gab723ef9be858b9aeb33600ca2d100bd0">XWT_CSR0_WRS_MASK</a>, and <a class="el" href="group__wdttb__v4__0.html#ga7acdd92b397bdfb0e14b649d4525bb2b">XWT_TWCSR0_OFFSET</a>.</p>

<p class="reference">Referenced by <a class="el" href="xwdttb__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
